Node / meshtastic / Meshtastic-Android / files / core / model / src / commonMain / kotlin / org / meshtastic / core / model / EventFirmware.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.core.model

Tff7b72import T7ee787kotlinx.serialization.ExperimentalSerializationApi

Tff7b72import T7ee787kotlinx.serialization.Serializable

Tff7b72import T7ee787kotlinx.serialization.json.JsonIgnoreUnknownKeys

T8b949e/**

* Response envelope for event-firmware display metadata. Matches the bundled `event_firmware.json` and the live `GET

* https://api.meshtastic.org/resource/eventFirmware` API (the source of truth), sharing the `{version, generatedAt,

* source, <payload>[]}` shape used by [NetworkDeviceLinksResponse].

*/

Tf0883e@Serializable

Tf0883e@OptInTb4b4b4(Te6edf3ExperimentalSerializationApiTff7b72::Te6edf3classTb4b4b4)

Tf0883e@JsonIgnoreUnknownKeys

Tff7b72data Tff7b72class T56d364EventFirmwareResponseTb4b4b4(

Tff7b72val Te6edf3versionTb4b4b4: Tffa657Int Tff7b72= T79c0ff1Tb4b4b4,

Tff7b72val Te6edf3generatedAtTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3sourceTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3editionsTb4b4b4: Te6edf3ListTff7b72<Te6edf3EventFirmwareEditionTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tb4b4b4)

T8b949e/**

* Display metadata for one event-specific firmware edition (Hamvention, DEFCON, …).

*

* @param edition the `FirmwareEdition` proto enum name, e.g. `HAMVENTION` — the key a connected device's reported

* edition is matched against.

* @param displayName human-readable name, e.g. `Hamvention` (vs the enum name `HAMVENTION`).

* @param welcomeMessage plain English welcome string. NOTE: intentionally not localized — moving it into data drops the

* Crowdin per-language translation the string resources gave; revisit with the upstream API (see PR #5920).

* @param eventStart ISO-8601 date (`YYYY-MM-DD`) the event begins, in [timeZone].

* @param eventEnd ISO-8601 date the event ends, in [timeZone].

* @param timeZone IANA time-zone id so [eventStart]/[eventEnd] resolve in the event's local time.

* @param location free-text venue/city for display.

* @param iconUrl URL of the event branding icon (hosted on api.meshtastic.org); bundled drawables are the fallback.

* @param accentColor `#RRGGBB` brand color for ambient theming.

* @param tag short label for the event, e.g. `Hamvention`.

* @param domain per-event microsite host, e.g. `hamvention.meshtastic.org`.

* @param theme richer branding (tagline, palette, …) layered over [accentColor]; optional, not all editions carry it.

* @param firmware the event's own firmware build (version + download); lets a client offer/flash it directly.

* @param links labeled links for the event (website, schedule, …).

*/

Tf0883e@Serializable

Tf0883e@OptInTb4b4b4(Te6edf3ExperimentalSerializationApiTff7b72::Te6edf3classTb4b4b4)

Tf0883e@JsonIgnoreUnknownKeys

Tff7b72data Tff7b72class T56d364EventFirmwareEditionTb4b4b4(

Tff7b72val Te6edf3editionTb4b4b4: Tffa657String Tff7b72= Ta5d6ff"Ta5d6ff"Tb4b4b4,

Tff7b72val Te6edf3displayNameTb4b4b4: Tffa657String Tff7b72= Ta5d6ff"Ta5d6ff"Tb4b4b4,

Tff7b72val Te6edf3welcomeMessageTb4b4b4: Tffa657String Tff7b72= Ta5d6ff"Ta5d6ff"Tb4b4b4,

Tff7b72val Te6edf3eventStartTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3eventEndTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3timeZoneTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3locationTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3iconUrlTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3accentColorTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3tagTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3domainTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3themeTb4b4b4: Te6edf3EventFirmwareTheme? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3firmwareTb4b4b4: Te6edf3EventFirmwareBuild? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3linksTb4b4b4: Te6edf3ListTff7b72<Te6edf3EventFirmwareLinkTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tb4b4b4)

T8b949e/** A labeled link for an event (website, schedule, map, …). */

Tf0883e@Serializable

Tf0883e@OptInTb4b4b4(Te6edf3ExperimentalSerializationApiTff7b72::Te6edf3classTb4b4b4)

Tf0883e@JsonIgnoreUnknownKeys

Tff7b72data Tff7b72class T56d364EventFirmwareLinkTb4b4b4(Tff7b72val Te6edf3labelTb4b4b4: Tffa657String Tff7b72= Ta5d6ff"Ta5d6ff"Tb4b4b4, Tff7b72val Te6edf3urlTb4b4b4: Tffa657String Tff7b72= Ta5d6ff"Ta5d6ff"Tb4b4b4)

T8b949e/** Richer event branding beyond a single accent color. Not all editions carry a full theme. */

Tf0883e@Serializable

Tf0883e@OptInTb4b4b4(Te6edf3ExperimentalSerializationApiTff7b72::Te6edf3classTb4b4b4)

Tf0883e@JsonIgnoreUnknownKeys

Tff7b72data Tff7b72class T56d364EventFirmwareThemeTb4b4b4(

Tff7b72val Te6edf3nameTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3taglineTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3colorsTb4b4b4: Te6edf3EventFirmwareThemeColors? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3paletteTb4b4b4: Te6edf3ListTff7b72<Tffa657StringTff7b72> Tff7b72= Te6edf3emptyListTb4b4b4(Tb4b4b4)Tb4b4b4,

Tff7b72val Te6edf3fontsTb4b4b4: Te6edf3EventFirmwareFonts? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)

T8b949e/**

* Font-family names for event branding — Google Font family names (e.g. `Lato` / `Atkinson Hyperlegible`), not URLs.

* Captured so the data is available; actually rendering with these fonts is a separate, platform-specific concern (a

* downloadable-font provider is Google-flavor only), so consumers may ignore them and fall back to the app typeface.

*/

Tf0883e@Serializable

Tf0883e@OptInTb4b4b4(Te6edf3ExperimentalSerializationApiTff7b72::Te6edf3classTb4b4b4)

Tf0883e@JsonIgnoreUnknownKeys

Tff7b72data Tff7b72class T56d364EventFirmwareFontsTb4b4b4(Tff7b72val Te6edf3headingTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4, Tff7b72val Te6edf3bodyTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4)

T8b949e/** Named brand colors (`#RRGGBB`) for an event theme; any may be absent. */

Tf0883e@Serializable

Tf0883e@OptInTb4b4b4(Te6edf3ExperimentalSerializationApiTff7b72::Te6edf3classTb4b4b4)

Tf0883e@JsonIgnoreUnknownKeys

Tff7b72data Tff7b72class T56d364EventFirmwareThemeColorsTb4b4b4(

Tff7b72val Te6edf3primaryTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3secondaryTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3accentTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)

T8b949e/** The event's own firmware release, so a client can surface its version or offer the download ([zipUrl]). */

Tf0883e@Serializable

Tf0883e@OptInTb4b4b4(Te6edf3ExperimentalSerializationApiTff7b72::Te6edf3classTb4b4b4)

Tf0883e@JsonIgnoreUnknownKeys

Tff7b72data Tff7b72class T56d364EventFirmwareBuildTb4b4b4(

Tff7b72val Te6edf3slugTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3versionTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3idTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3titleTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3zipUrlTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3releaseNotesTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)